Datasources APIs

Data Source APIs for managing data sources and data models

Function

Description

Version

Examples

Ent. Admin

Dom. Admin

Pro User

Analyst User

Viewer User

Basic User

addHierarchyOverlayToModel

Set hierarchy overlay properties

2020.26

addHierarchySecurityToModel

Applies data security to model attribute hierarchies

2020.0

addMeasureOverlayToModel

Set measure overlay properties

2020.27

addMeasureSecurityToModel

Applies data security to model measures

2020.0

addMembersSecurityToModel

Applies data security to hierarchy members

2020.0

addRolesToDataBase

Add Roles to a Data Source Database

2018.5

addRolesToItemAndBubbleUp

Add roles to a data source item with bubble up.

2020.0

addRolesToItemAndPropagate

Add roles to a data source item with propagate down.

2020.0

addRolesToModel

Add Roles to a Materialized Model

2018.5

addRolesToServer

Add Roles to a Data Source Server

2018.5

changeDataSource

Change an Item's Data Source

2018.5

changeDataSources

Change Items Data Sources

2023.10

createDataServer

Create a new Data Source

2018.5

createDataServers

Create Multiple Data Sources from a List

2018.5

deleteDataBase

Delete an Existing Database

2018.5

deleteDataSource

Delete a Data Source

2018.5

deleteHierarchyOverlayFromModel

Removes hierarchy overlay properties

2020.26

deleteHierarchySecurityFromModel

Remove data security from model attribute hierarchies

2020.26

deleteMaterializedModel

Delete a Materialized Model

2018.5

deleteMeasureOverlayFromModel

Removes measure overlay properties

2020.27

deleteMeasureSecurityFromModel

Remove data security from model measures

2020.26

deleteMembersSecurityFromModel

Removes data security from hierarchy members

2020.26

deleteRolesFromDatabase

Delete Roles from a Data Source Database

2018.5

deleteRolesFromModel

Delete Roles from a Materialized Model

2018.5

deleteRolesFromServer

Delete Roles from a Data Source Server

2018.5

executeMasterFlow

Executes a Master Flow

2020.20

exportMaterializedModelDataCatalog

Returns the data catalog for a materialized model

2023.10

exportModel

Export a PIE file

2018.5

findDatabaseByName

Find a Data Source Database

2018.5

findModelByName

Find a Materialized model

2018.5

findServerByName

Find a Data Source Server

2018.5

getAllConnectionStrings

Get all Data Connections

2018.5

getDataModelStructure

Extract the structure of a data model

2020.0

getDataSourcesByTenant

Get all Datasources for a Tenant.

2018.5.2

getDataSourcesByUserId

Get an Tenant's Data Sources

2020.0

getDatasourceUsedTables

Get data source used tables.

2020.23

getHierarchySecurity

Get measure security properties

2023.10

getItemConnectionString

Get an Item's Data Source Details

2018.5

getMasterFlowProgressUpdate

Get Master Flow Execution Progress

2020.20

getMasterFlowVariables

Get all variables in a Master Flow

2020.20

getMeasureSecurity

Get hierarchy security properties

2023.10

getMemberSecurity

Get members security properties

2023.10

getModelHierarchyOverlay

Get hierarchy overlay properties

2023.10

getModelMeasureOverlay

Get measure overlay properties

2023.10

getPulseNodesForTenant

Returns information about a tenant's Pulse clients

2023.00

getRolesByDataBase

Get Data Source Database Roles

2018.5

getRolesByModel

Get Materialized Model Roles

2018.5

getRolesByServer

Get Data Source Server Roles

2018.5

getServerDataById

Get a Server's Data Details

2020.0

getSourceByNodeId

Get a specific Data Source by Data Flow Node ID

2020.20

getTargetByNodeId

Get a specific Data Target by Data Flow Node ID

2020.20

getUserDataCatalog

Returns the data catalog for a model

2023.00

importMaterializedModelDataCatalog

Updates the data catalog for a materialized model

2023.10

importModel

Import a Data Model

2018.5

recognizeDataBase

Recognize a Database

2018.5

recognizeModel

Recognize an existing Data Model

2020.0

searchConnectionString

Find Semantic Data Models

2023.10

updateDataFlowNodeSchemas

Update data source used schemas.

2020.23

updateModelName

Update model name.

2020.23

updateModelProcessDate

Updates a model's process date

2023.00

updateSourceNodeConnection

Update the Connection for a Data Source

2020.20

updateTargetNodeConnection

Update the Connection for a Data Target

2020.20

updateVariableConnection

Update the Connection for a Variable

2020.20

updateVariableValue

Sets the values of a list of variables

2020.20

validateMasterFlow

Validates a Master Flow

2020.20